Remove :rdoc Rake task in generated plugin #38574
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonathanhefner
force-pushed
the
plugin-remove-rdoc-rake-task
branch
from
82506f1
to
9698e4d
Compare
jonathanhefner
force-pushed
the
plugin-remove-rdoc-rake-task
branch
from
9698e4d
to
3274572
Compare
|
@rafaelfranca Done! |
jonathanhefner
force-pushed
the
plugin-remove-rdoc-rake-task
branch
from
3274572
to
906326f
Compare
The `rdoc lib` command produces nearly the same output as `rake rdoc`. The `rdoc lib` command also has the benefit of being standard, whereas Rake subcommands can vary from project to project. Since the purpose of either command is to support local development, as opposed to generating official docs for consumption by e.g. rubygems, the standard command seems preferable. Note that the `rdoc` command outputs to the doc/ directory by default, so this commit also adds that directory to the plugin .gitignore file.
jonathanhefner
force-pushed
the
plugin-remove-rdoc-rake-task
branch
from
906326f
to
677eac6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
rdoc libcommand produces nearly the same output asrake rdoc. Therdoc libcommand also has the benefit of being standard, whereas Rake subcommands can vary from project to project. Since the purpose of either command is to support local development, as opposed to generating official docs for consumption by e.g. rubygems, the standard command seems preferable.Note that the
rdoccommand outputs to thedoc/directory by default, so this commit also adds that directory to the plugin.gitignorefile.